Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: adding docs conventional commit, adapt conditional labeling #3267

Closed
wants to merge 1 commit into from
Closed

chore: adding docs conventional commit, adapt conditional labeling #3267

wants to merge 1 commit into from

Conversation

signorecello
Copy link
Contributor

Description

Adds the docs conventional commit, and uses it to trigger conditional labelling

Problem*

Not exactly a problem, just another way to trigger the documentation label and provide a preview

Summary*

  • Adds a docs type on the CONTRIBUTING guide.
  • Refactors the build-docs workflow to check for PR title and apply label if it matches the type

@signorecello signorecello changed the title docs: adding docs conventional commit, adapt conditional labeling chore: adding docs conventional commit, adapt conditional labeling Oct 24, 2023
TomAFrench
TomAFrench reviewed Oct 24, 2023
View reviewed changes
Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make sure that these PRs won't appear in the changelog? chore PRs don't get included there.

@kevaundray
Copy link
Contributor

We have something similar on the aztec-packages repo, where sometimes folks use chore(docs): and other times docs: -- I'd prefer to have only one way to do this and we standardize around that

@signorecello
Copy link
Contributor Author

I'll check what they have and copy it, I also want it to be consistent

@signorecello
Copy link
Contributor Author

So, apparently docs should be a "scope" and not a type. Being that we don't currently care about scopes yet. This kind of makes sense, as changes in the docs shouldn't trigger any versioning.

I'll remove this from the conventional commits

@signorecello
Copy link
Contributor Author

actually I'll drop the PR because it's useless now lol

@signorecello signorecello deleted the zpedro/conventional_commit_docs branch October 24, 2023 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAFrench TomAFrench TomAFrench left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@signorecello @kevaundray @TomAFrench